Agent Skills 格式規格
前言
本文件定義了 Agent Skills 的格式規格,涵蓋目錄結構、SKILL.md 檔案格式、frontmatter 欄位規範、漸進式揭露機制以及驗證方式。
目錄結構
一個 Skill 是一個至少包含 SKILL.md 檔案的目錄:
skill-name/
└── SKILL.md # 必要
提示
你可以選擇性地加入額外的目錄,例如 scripts/、references/ 和 assets/ 來支援你的 Skill。
SKILL.md 格式
SKILL.md 檔案必須包含 YAML frontmatter,後接 Markdown 內容。
Frontmatter(必要)
---
name: skill-name
description: A description of what this skill does and when to use it.
---
加上選用欄位的範例:
---
name: pdf-processing
description: Extract text and tables from PDF files, fill forms, merge documents.
license: Apache-2.0
metadata:
author: example-org
version: "1.0"
---
| 欄位 | 必要 | 限制 |
|---|---|---|
name | 是 | 最多 64 個字元。僅限小寫字母、數字和連字號。不得以連字號開頭或結尾。 |
description | 是 | 最多 1024 個字元。不得為空。描述此 Skill 的功能及使用時機。 |
license | 否 | 授權名稱或附帶的授權檔案參考。 |
compatibility | 否 | 最多 500 個字元。說明環境需求(目標產品、系統套件、網路存取等)。 |
metadata | 否 | 任意的鍵值對映射,用於額外的中繼資料。 |
allowed-tools | 否 | 以空格分隔的預先核准工具清單,供 Skill 使用。(實驗性功能) |
name 欄位
必要的 name 欄位:
- 必須為 1-64 個字元
- 僅能包含 Unicode 小寫英數字元和連字號(
a-z和-) - 不得以
-開頭或結尾 - 不得包含連續的連字號(
--) - 必須與上層目錄名稱一致
合法範例:
name: pdf-processing
name: data-analysis
name: code-review
不合法範例:
name: PDF-Processing # 不允許大寫
name: -pdf # 不能以連字號開頭
name: pdf--processing # 不允許連續的連字號
description 欄位
必要的 description 欄位:
- 必須為 1-1024 個字元
- 應描述此 Skill 的功能及使用時機
- 應包含能幫助代理辨識相關任務的特定關鍵字
好的範例:
description: Extracts text and tables from PDF files, fills PDF forms, and merges multiple PDFs. Use when working with PDF documents or when the user mentions PDFs, forms, or document extraction.
不好的範例:
description: Helps with PDFs.